<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>csudma: xcsudma_intr_example.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.gif"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">csudma
   </div>
   <div id="projectbrief">Xilinx SDK Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xcsudma__intr__example_8c.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a>  </div>
  <div class="headertitle">
<div class="title">xcsudma_intr_example.c File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<div class="textblock"><p>This file contains a design example using the <a class="el" href="struct_x_csu_dma.html" title="The XCsuDma driver instance data structure. ">XCsuDma</a> driver in interrupt mode. </p>
<p>It sends data and expects to receive the same data through the device using the local loop back mode.</p>
<dl class="section note"><dt>Note</dt><dd>The example contains an infinite loop such that if interrupts are not working it may hang.</dd></dl>
<pre>
MODIFICATION HISTORY:</pre><pre>Ver   Who     Date     Changes
<hr/>

1.0   vnsld  22/10/14 First release
</pre> </div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ae187885a3ceac7f6fbeeef796f2cd075"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xcsudma__intr__example_8c.html#ae187885a3ceac7f6fbeeef796f2cd075">INTG_CSUDMA_INTR_DEVICE_ID</a>&#160;&#160;&#160;XPAR_XCSUDMA_INTR</td></tr>
<tr class="memdesc:ae187885a3ceac7f6fbeeef796f2cd075"><td class="mdescLeft">&#160;</td><td class="mdescRight">Interrupt device ID of CSU DMA device ID.  <a href="#ae187885a3ceac7f6fbeeef796f2cd075">More...</a><br /></td></tr>
<tr class="separator:ae187885a3ceac7f6fbeeef796f2cd075"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1dac2e3409004e3277582a4066239395"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xcsudma__intr__example_8c.html#a1dac2e3409004e3277582a4066239395">CSU_SSS_CONFIG_OFFSET</a>&#160;&#160;&#160;0x008</td></tr>
<tr class="memdesc:a1dac2e3409004e3277582a4066239395"><td class="mdescLeft">&#160;</td><td class="mdescRight">CSU SSS_CFG Offset.  <a href="#a1dac2e3409004e3277582a4066239395">More...</a><br /></td></tr>
<tr class="separator:a1dac2e3409004e3277582a4066239395"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a36650147b2834be4261c304cbb5acbfb"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xcsudma__intr__example_8c.html#a36650147b2834be4261c304cbb5acbfb">CSUDMA_LOOPBACK_CFG</a>&#160;&#160;&#160;0x00000050</td></tr>
<tr class="memdesc:a36650147b2834be4261c304cbb5acbfb"><td class="mdescLeft">&#160;</td><td class="mdescRight">LOOP BACK configuration macro.  <a href="#a36650147b2834be4261c304cbb5acbfb">More...</a><br /></td></tr>
<tr class="separator:a36650147b2834be4261c304cbb5acbfb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac3d8dffdc62a3f278989d9be3029c81f"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xcsudma__intr__example_8c.html#ac3d8dffdc62a3f278989d9be3029c81f">SRC_ADDR</a>&#160;&#160;&#160;0x04200000</td></tr>
<tr class="memdesc:ac3d8dffdc62a3f278989d9be3029c81f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Source Address.  <a href="#ac3d8dffdc62a3f278989d9be3029c81f">More...</a><br /></td></tr>
<tr class="separator:ac3d8dffdc62a3f278989d9be3029c81f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afae12ac043a663635a5132cffa62458b"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xcsudma__intr__example_8c.html#afae12ac043a663635a5132cffa62458b">DST_ADDR</a>&#160;&#160;&#160;0x04300000</td></tr>
<tr class="memdesc:afae12ac043a663635a5132cffa62458b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destination Address.  <a href="#afae12ac043a663635a5132cffa62458b">More...</a><br /></td></tr>
<tr class="separator:afae12ac043a663635a5132cffa62458b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a70ed59adcb4159ac551058053e649640"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xcsudma__intr__example_8c.html#a70ed59adcb4159ac551058053e649640">SIZE</a>&#160;&#160;&#160;0x100</td></tr>
<tr class="memdesc:a70ed59adcb4159ac551058053e649640"><td class="mdescLeft">&#160;</td><td class="mdescRight">Size of the data to be transfered.  <a href="#a70ed59adcb4159ac551058053e649640">More...</a><br /></td></tr>
<tr class="separator:a70ed59adcb4159ac551058053e649640"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a8a033d6b8dab6a393181c511d85f0ef3"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xcsudma__intr__example_8c.html#a8a033d6b8dab6a393181c511d85f0ef3">XCsuDma_IntrExample</a> (u16 DeviceId)</td></tr>
<tr class="memdesc:a8a033d6b8dab6a393181c511d85f0ef3"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function performs data transfer in loop back mode in interrupt mode and verify the data.  <a href="#a8a033d6b8dab6a393181c511d85f0ef3">More...</a><br /></td></tr>
<tr class="separator:a8a033d6b8dab6a393181c511d85f0ef3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa2c2d73f33aa4a715c8b8b3c0c01ada6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xcsudma__intr__example_8c.html#aa2c2d73f33aa4a715c8b8b3c0c01ada6">IntrHandler</a> (void *CallBackRef)</td></tr>
<tr class="memdesc:aa2c2d73f33aa4a715c8b8b3c0c01ada6"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is the interrupt handler for the CSU_DMA driver.  <a href="#aa2c2d73f33aa4a715c8b8b3c0c01ada6">More...</a><br /></td></tr>
<tr class="separator:aa2c2d73f33aa4a715c8b8b3c0c01ada6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a840291bc02cba5474a4cb46a9b9566fe"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xcsudma__intr__example_8c.html#a840291bc02cba5474a4cb46a9b9566fe">main</a> (void)</td></tr>
<tr class="memdesc:a840291bc02cba5474a4cb46a9b9566fe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Main function to call the example.  <a href="#a840291bc02cba5474a4cb46a9b9566fe">More...</a><br /></td></tr>
<tr class="separator:a840291bc02cba5474a4cb46a9b9566fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:a6ac1478432df4951ce8f0fc753bb652d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_x_csu_dma.html">XCsuDma</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xcsudma__intr__example_8c.html#a6ac1478432df4951ce8f0fc753bb652d">CsuDma</a></td></tr>
<tr class="memdesc:a6ac1478432df4951ce8f0fc753bb652d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Instance of the Csu_Dma Device.  <a href="#a6ac1478432df4951ce8f0fc753bb652d">More...</a><br /></td></tr>
<tr class="separator:a6ac1478432df4951ce8f0fc753bb652d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a1dac2e3409004e3277582a4066239395"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1dac2e3409004e3277582a4066239395">&#9670;&nbsp;</a></span>CSU_SSS_CONFIG_OFFSET</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define CSU_SSS_CONFIG_OFFSET&#160;&#160;&#160;0x008</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>CSU SSS_CFG Offset. </p>

</div>
</div>
<a id="a36650147b2834be4261c304cbb5acbfb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a36650147b2834be4261c304cbb5acbfb">&#9670;&nbsp;</a></span>CSUDMA_LOOPBACK_CFG</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define CSUDMA_LOOPBACK_CFG&#160;&#160;&#160;0x00000050</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>LOOP BACK configuration macro. </p>

</div>
</div>
<a id="afae12ac043a663635a5132cffa62458b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afae12ac043a663635a5132cffa62458b">&#9670;&nbsp;</a></span>DST_ADDR</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define DST_ADDR&#160;&#160;&#160;0x04300000</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Destination Address. </p>

</div>
</div>
<a id="ae187885a3ceac7f6fbeeef796f2cd075"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae187885a3ceac7f6fbeeef796f2cd075">&#9670;&nbsp;</a></span>INTG_CSUDMA_INTR_DEVICE_ID</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define INTG_CSUDMA_INTR_DEVICE_ID&#160;&#160;&#160;XPAR_XCSUDMA_INTR</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Interrupt device ID of CSU DMA device ID. </p>

</div>
</div>
<a id="a70ed59adcb4159ac551058053e649640"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a70ed59adcb4159ac551058053e649640">&#9670;&nbsp;</a></span>SIZE</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define SIZE&#160;&#160;&#160;0x100</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Size of the data to be transfered. </p>

</div>
</div>
<a id="ac3d8dffdc62a3f278989d9be3029c81f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac3d8dffdc62a3f278989d9be3029c81f">&#9670;&nbsp;</a></span>SRC_ADDR</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define SRC_ADDR&#160;&#160;&#160;0x04200000</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Source Address. </p>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="aa2c2d73f33aa4a715c8b8b3c0c01ada6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa2c2d73f33aa4a715c8b8b3c0c01ada6">&#9670;&nbsp;</a></span>IntrHandler()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void IntrHandler </td>
          <td>(</td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>CallBackRef</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function is the interrupt handler for the CSU_DMA driver. </p>
<p>This handler reads the interrupt status from the Status register, determines the source of the interrupts, calls according callbacks, and finally clears the interrupts.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">CallBackRef</td><td>is the callback reference passed from the interrupt handler, which in our case is a pointer to the driver instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

</div>
</div>
<a id="a840291bc02cba5474a4cb46a9b9566fe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a840291bc02cba5474a4cb46a9b9566fe">&#9670;&nbsp;</a></span>main()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int main </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Main function to call the example. </p>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if successful.</li>
<li>XST_FAILURE if failed.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

</div>
</div>
<a id="a8a033d6b8dab6a393181c511d85f0ef3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8a033d6b8dab6a393181c511d85f0ef3">&#9670;&nbsp;</a></span>XCsuDma_IntrExample()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XCsuDma_IntrExample </td>
          <td>(</td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>DeviceId</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function performs data transfer in loop back mode in interrupt mode and verify the data. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">DeviceId</td><td>is the XPAR_&lt;CSUDMA Instance&gt;_DEVICE_ID value from xparameters.h.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if successful.</li>
<li>XST_FAILURE if failed.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a id="a6ac1478432df4951ce8f0fc753bb652d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6ac1478432df4951ce8f0fc753bb652d">&#9670;&nbsp;</a></span>CsuDma</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_x_csu_dma.html">XCsuDma</a> CsuDma</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Instance of the Csu_Dma Device. </p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="footer">Copyright &copy; 2015 Xilinx Inc. All rights reserved.</li>
  </ul>
</div>
</body>
</html>
